/**
 * (C) Copyright IBM Corp. 2018, 2020.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 **/

import Foundation

/**
 An error associated with a word from a custom language model.
 */
public struct WordError: Codable, Equatable {

    /**
     A key-value pair that describes an error associated with the definition of a word in the words resource. The pair
     has the format `"element": "message"`, where `element` is the aspect of the definition that caused the problem and
     `message` describes the problem. The following example describes a problem with one of the word's sounds-like
     definitions: `"{sounds_like_string}": "Numbers are not allowed in sounds-like. You can try for example
     '{suggested_string}'."`.
     */
    public var element: String

    // Map each property name to the key that shall be used for encoding/decoding.
    private enum CodingKeys: String, CodingKey {
        case element = "element"
    }

}
